Refactor File.Content to use discriminated union with MIME types #3108
Conversation
|
@kmk142789 please stop reviewing prs, the review doesnt do anything since you arent a maintainer and it can lead to confusion with those trying to contribute |
|
@kcrommett ill peep this today thanks! |
packages/opencode/src/file/index.ts
Outdated
| const mimeTypes: Record<string, string> = { | ||
| ".jpg": "image/jpeg", | ||
| ".jpeg": "image/jpeg", | ||
| ".png": "image/png", | ||
| ".gif": "image/gif", | ||
| ".bmp": "image/bmp", | ||
| ".webp": "image/webp", | ||
| ".ico": "image/x-icon", | ||
| ".svg": "image/svg+xml", | ||
| ".zip": "application/zip", | ||
| ".tar": "application/x-tar", | ||
| ".gz": "application/gzip", | ||
| ".pdf": "application/pdf", | ||
| ".wasm": "application/wasm", | ||
| ".exe": "application/x-msdownload", | ||
| ".dll": "application/x-msdownload", | ||
| ".so": "application/x-sharedlib", | ||
| } | ||
| return mimeTypes[ext] || "application/octet-stream" | ||
| } | ||
|
|
There was a problem hiding this comment.
Doesn't the bun api return the mime type automatically?
| const content = Buffer.from(buffer).toString("base64") | ||
| return { type: "binary", content, mimeType: getMimeType(full) } | ||
| } | ||
|
|
There was a problem hiding this comment.
For images would it be best to base64 encode them here? Should we return raw bytes?
Idk maybe we should take some inspiration from S3 on this one...
Whats the most common?
There was a problem hiding this comment.
Sticking with base64. We’re shipping file content inside a JSON payload so it needs to be text-safe, and base64 is the de facto approach (AWS S3’s JSON APIs do the same). Returning raw bytes would force a binary response instead of the existing schema, so we’d lose compatibility with the current endpoint. With the new encoding: "base64" flag, clients can reliably decode via Buffer.from(content, "base64") or similar.
There was a problem hiding this comment.
sweet ill test your latest changes and then this should be good to go.
3 participants
Summary
File.Contentto a discriminated union for type-safe text vs binaryhandling
cs
Changes
File.Contentwith a discriminated union keyed bytype:text:{ type: "text", content, diff?, patch? }binary:{ type: "binary", content /* base64 */, mimeType }getMimeType(path)with common extension map andapplication/octet-strea mfallbackisBinaryFile(path, file)using extension heuristics plus a null-byte scan of the first up to 512 bytes
read(path):binarywith base64 content andmimeTypefor detected binariestextcontent; when tracked in git, computediffand fullpatch(tries unstaged, then staged)
FileContentas a discriminated unionBenefits
ver and SDK
mimeTypemetadata enables correct client-side rendering and processing
textvariant; binary is base64 with metadatacontent.typediscriminator